Api.RemoveVariable method

Removes a user-defined variable.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

public KsError RemoveVariable(
       UserVariable Variable
)

Public Function RemoveVariable(
       Variable As UserVariable
) As KsError

Parameters

Variable

Type: UserVariable

The variable you want to remove.

Return value

Type: KsError

A return code of a method.

Remarks

User variables cannot be deleted using RemoveVariable when the variables are used by Debug methods or Log.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace